Skip to content

Add Helm chart for deployment-tracker#62

Open
bdehamer wants to merge 5 commits intomainfrom
bdehamer/helm
Open

Add Helm chart for deployment-tracker#62
bdehamer wants to merge 5 commits intomainfrom
bdehamer/helm

Conversation

@bdehamer
Copy link

@bdehamer bdehamer commented Mar 20, 2026 •
edited
Loading

Summary

Adds a Helm chart to make it easy for customers to install the deployment-tracker controller. The chart is co-located in the repo under deploy/charts/deployment-tracker/, following the pattern used by cert-manager and external-secrets.

What's included

Helm chart (deploy/charts/deployment-tracker/)

  • Chart.yaml — chart metadata (apiVersion v2, type application)
  • values.yaml — all configurable options with sensible defaults:
    • Image config (ghcr.io/github/deployment-tracker)
    • Controller config (org, logicalEnvironment, cluster, baseUrl, dnTemplate, namespace filtering, workers, metricsPort)
    • Auth — supports both API token and GitHub App, with inline values or references to existing K8s Secrets
    • Resources, security context, readiness probe, lifecycle hooks (matching internal production config)
    • Service, ServiceAccount, pod annotations, node scheduling
  • Templates: ServiceAccount, ClusterRole, ClusterRoleBinding, Deployment, Service, NOTES.txt
  • _helpers.tpl — standard Helm name/label/selector helpers
  • README.md — configuration docs with install examples and auth setup

CI workflow updates

  • release.yaml — on tag push, now also packages and pushes the Helm chart as an OCI artifact to oci://ghcr.io/github/charts alongside the container image build
  • build.yml — new helm-lint job runs helm lint and helm template validation on PRs and pushes to main

Install

helm install deployment-tracker \
  oci://ghcr.io/github/charts/deployment-tracker \
  --namespace deployment-tracker --create-namespace \
  --set config.org=my-org \
  --set config.logicalEnvironment=production \
  --set config.cluster=my-cluster \
  --set auth.apiTokenSecret=my-secret

Design decisions

  • Chart in-repo (not a separate repo) — chart and controller are tightly coupled; co-location allows atomic changes and simpler CI
  • OCI publishing to ghcr.io — modern Helm best practice, no index.yaml maintenance, co-locates chart with container image
  • Auth via Secret references — recommended for production; inline values supported for dev/testing
  • Required values enforced — config.org, config.logicalEnvironment, and config.cluster are validated at template time

@bdehamer
add helm chart
23cf2f0 
Signed-off-by: Brian DeHamer <bdehamer@github.com>
@kommendorkapten
Copy link
Member

kommendorkapten commented Mar 20, 2026

How about support for a GitHub app as I think that is a popular method for authentication?

@bdehamer
Copy link
Author

bdehamer commented Mar 20, 2026

How about support for a GitHub app as I think that is a popular method for authentication?

@kommendorkapten there's a section in the readme explaining how to auth with a GitHub App.

@kommendorkapten
Copy link
Member

kommendorkapten commented Mar 20, 2026

Perfect, and it's in the values.yaml too 👍

@bdehamer
set default version to 0.0.0
1dc85c7 
Signed-off-by: Brian DeHamer <bdehamer@github.com>
@bdehamer bdehamer marked this pull request as ready for review March 20, 2026 19:53
@bdehamer bdehamer requested a review from a team as a code owner March 20, 2026 19:53
Copilot AI review requested due to automatic review settings March 20, 2026 19:53
Copilot AI reviewed Mar 20, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Introduces an in-repo Helm chart to install and configure the deployment-tracker controller, and updates CI/release workflows to lint the chart on PRs and publish it as an OCI artifact on tag releases.

Changes:

  • Added a Helm chart under deploy/charts/deployment-tracker/ (values, templates, docs, chart metadata).
  • Added a CI job to helm lint and helm template the chart.
  • Updated the release workflow to package and push the chart to GHCR as an OCI artifact alongside the container image.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
deploy/charts/deployment-tracker/Chart.yaml New chart metadata (name/version/appVersion/kubeVersion).
deploy/charts/deployment-tracker/values.yaml Default configuration surface for controller, auth, service, and runtime settings.
deploy/charts/deployment-tracker/templates/deployment.yaml Renders the controller Deployment, wiring config/auth via args/env and exposing metrics.
deploy/charts/deployment-tracker/templates/serviceaccount.yaml Optional ServiceAccount creation (and imagePullSecrets).
deploy/charts/deployment-tracker/templates/clusterrole.yaml ClusterRole for controller access to Kubernetes resources.
deploy/charts/deployment-tracker/templates/clusterrolebinding.yaml ClusterRoleBinding wiring the ClusterRole to the ServiceAccount.
deploy/charts/deployment-tracker/templates/service.yaml Optional metrics Service.
deploy/charts/deployment-tracker/templates/_helpers.tpl Standard naming/label helpers for the chart.
deploy/charts/deployment-tracker/templates/NOTES.txt Post-install guidance and basic validation warnings.
deploy/charts/deployment-tracker/README.md Installation/configuration documentation for the chart.
deploy/charts/deployment-tracker/.helmignore Packaging ignore rules for Helm chart artifacts.
.github/workflows/build.yml Adds helm-lint job to validate chart on PRs and main pushes.
.github/workflows/release.yaml Packages and pushes the chart to GHCR on version tag pushes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bdehamer
Update deploy/charts/deployment-tracker/templates/clusterrole.yaml
1bdd11c 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link

Copilot AI commented Mar 20, 2026

@bdehamer I've opened a new pull request, #65, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI mentioned this pull request Mar 20, 2026
Merged
Copilot AI and others added 2 commits March 20, 2026 13:47
@bdehamer
Add Helm template validation for mutually exclusive namespace flags (#65
3ed5e00 
)

* Initial plan

* Add template-time validation for mutually exclusive namespace flags

Co-authored-by: bdehamer <398027+bdehamer@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/deployment-tracker/sessions/ab6214f1-4681-454f-b5de-7d0caa1a9cc9

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bdehamer <398027+bdehamer@users.noreply.github.com>
@bdehamer
Update deploy/charts/deployment-tracker/templates/_helpers.tpl
86a91a7 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bdehamer @kommendorkapten